Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

48 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📝 SpecToDocs (Docs-Hub)

"Swagger JSON만 던지세요. 가장 힙한 마크다운 API 명세서로 바꿔드립니다."


📖 프로젝트 소개

개발자들은 협업을 위해 API 명세서를 작성하지만, Swagger UI는 그 자체로는 가독성이 떨어지고 노션이나 깃허브 위키에 마크다운으로 다시 옮겨 적는 건 매번 반복되는 번거로운 작업입니다. 이 불편함을 실제로 겪고 나서, Swagger/OpenAPI Spec을 올리면 1초 만에 깔끔한 마크다운 문서로 변환해주는 도구를 개인 프로젝트로 직접 만들었습니다. 기획부터 개발, 배포까지 전 과정을 혼자 진행했습니다.

항목 내용
역할 1인 개발 (기획 · 백엔드 · 배포)
배포 🔗 www.spectodocs.cloud
현황 MVP 배포 후 데이터 약 150건 누적

🔥 핵심 기능 (MVP)

  • Swagger/OpenAPI 3.0 파싱 엔진: 복잡한 API 구조(JSON)를 자바 객체로 완전 매핑
  • 마크다운 테이블 자동 조립: API 엔드포인트, HTTP 메서드, 응답 상태 코드를 가독성 높은 마크다운 표로 자동 변환
  • 보안 취약점 제어: 의존성 주입 과정에서 발생한 이행적 종속성(Rhino DoS 취약점, CVE-2025-66453)을 exclude 전략으로 제거

🛠 Tech Stack (Backend)

프론트엔드 스택 및 실행 방법은 SpecTodocs-Frontend 레포를 참고하세요.


🏗️ Architecture

MVP 단계에서는 별도 DB 연동 없이 백엔드의 파싱·변환 성능에만 집중한 고성능 컨버터 구조로 시작했으며, 이후 문서 저장·이력 조회를 위한 데이터 적재가 추가되었습니다.


🔗 Links

About

마크다운(Markdown) 기반 개발 템플릿 및 API 문서 자동화 저장소

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages